Draft: Format .cabal files with cabal-fmt #4230
Conversation
haskell-language-server.cabal
Outdated
|
|
||
| library | ||
| import: common-deps | ||
| -- configuration |
There was a problem hiding this comment.
Right, so this is what I remembered and is IMO a deal-breaker for cabal-fmt: it doesn't preserve comments properly. cabal-gild seems better (but not perfect), so that's a strong preference for me.
fendor
force-pushed
the
enhance/format-with-cabal-fmt
branch
from
9e7071e
to
a8708fc
Compare
|
|
||
| ghc-options: -Werror -Wwarn=unused-packages | ||
|
|
||
| -- Note [unused-packages] |
There was a problem hiding this comment.
Comment moved from where it belongs.
|
|
||
| -- FIXME: Only needed to workaround for qualified imports in GHC 9.4 |
| autogen-modules: Paths_haskell_language_server | ||
| ghc-options: -threaded -rtsopts "-with-rtsopts=-I0 -A128M" | ||
|
|
||
| -- allow user RTS overrides |
|
|
||
| if flag(isolateCabalfmtTests) | ||
| if flag(isolatecabalfmttests) |
There was a problem hiding this comment.
TIL Cabal converts flag names to lowercase.
There was a problem hiding this comment.
This is weird, is that cabal-fmt preference? It seems like cabal-gild doesn't convert to lower case.
There was a problem hiding this comment.
Gild currently doesn't convert flags to lowercase, but it probably will after I fix tfausak/cabal-gild#72. Conditionals in Cabal are represented by Condition ConfVar, which can have a FlagName in them. I can't currently find any documentation about it, but flag names are explicitly converted to lowercase when parsing: https://github.com/haskell/cabal/blob/03d98294e1c071be368f04dbe6fc9cb263bea86d/Cabal-syntax/src/Distribution/Types/Flag.hs#L117
There was a problem hiding this comment.
There's some discussion here (and in linked issues): haskell/cabal#5043
There was a problem hiding this comment.
FWIW I think that just because cabal compares flag names case-insensitively, that's not necessarily a reason to normalize the user's flag name to lower-case. And it would be fairly unwelcome...
There was a problem hiding this comment.
Starting with version 1.3.1.3, Gild now behaves the same as cabal-fmt in that it converts flag names into lowercase. This is a consequence of going through the FlagName type from Cabal-syntax.
Compare with #4229